home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / time / TitleC1001_105.readme < prev    next >
Text File  |  1995-02-12  |  11KB  |  267 lines

  1. Short:    WB Titleclock, very configurable
  2. Author:   henryk.richter@stud.uni-rostock.de
  3. Uploader: henryk.richter@stud.uni-rostock.de
  4. Type:     util/time
  5.  
  6.  
  7.                        TitleClock 1.05 (01-Feb-95)
  8.                        ---------------------------
  9.                         by Henryk "Buggs" Richter
  10.  
  11.  
  12. Purpose
  13. -------
  14.  
  15. TitleClock is just another little Workbench Title digital clock but this
  16. time with some special features. I know that there are 1000 other ones out
  17. doing the same job but mine can do a little bit more. It was written to
  18. be used in combination tools like with "MultiCX" by Martin Berndt to replace
  19. almost all really important functions of programs like "Kcommodity" but
  20. consuming much less memory. It works 100% conform to the style guide and
  21. does not patch any system function. So it should run on any machine equipped
  22. with OS2.x/3.x. 
  23.  
  24.  
  25. A short list of features:
  26. -------------------------
  27.  
  28. - almost completely configurable output, e.g.
  29.   "OutPutFormat=%W, Time: %h:%n:%s  %D-%m-%Y ->DFT Rulez<-" causes it showing
  30.   "Saturday, Time: 20:42:12  10-Dec-1994 ->DFT Rulez<-"
  31. - appears at the right side of the workbench title and doesn`t open a
  32.   disturbing window
  33. - Workbench screen may be closed meanwhile Titleclock is active so you can
  34.   change your prefs without having to close any window.
  35. - Supports a "MEM"-gauge with a variable size from 10 Pixels to 990 Pixels
  36.   wide + selectable memory type to show
  37. - The program is a commodity so you can control it using Commodities
  38.   Exchange.
  39. - Can be easily removed by starting it again or sending a "break" signal
  40.   using a usual system monitor.
  41. - 100% font sensitive
  42. - detects automatically the colors used in titlebar
  43. - comes along with Icons for NewIcons AND MagicWB
  44. - re-entrant, 100% PC relative code
  45. - locale support using the standard strings so that this program works with
  46.   every localized language (Kick 2.1+)
  47. - option to calculate the Stardate
  48. - quite short !! Hey, C and E programmers! Try to do this by using your
  49.   High-level languages, hehe
  50.  
  51.  
  52. Installation:
  53. -------------
  54.  
  55. Just drag the icon into the drawer you want. (usually sys:WBStartup)
  56.  
  57.  
  58. Starting:
  59. ---------
  60.  
  61. Double click onto the Icon. (What else)
  62.  
  63.  
  64. Configuration:
  65. --------------
  66.  
  67. The program countains no gui. This saves lots of memory from being wasted.
  68. Therefore the configuration is done using the tooltypes.
  69.  
  70.  
  71. OutPutFormat=????     Here you enter the line for your output string
  72.                       template. You may use any printable character and
  73.                       some offered variables. Those may be combined in any
  74.                       way you like (double, triple or even four times, no
  75.                       problem).
  76.                       The special variables:
  77.  
  78.                       %h -> hours in 24h military/European format
  79.                       %H -> hours in 12h American format
  80.                       %a -> "AM"/"PM"
  81.  
  82.                       %n -> minutes
  83.                       %s -> seconds
  84.  
  85.                       %D -> day
  86.  
  87.                       %N -> month as number
  88.                       %m -> month as short string (Jan,Feb,Mar...)
  89.                       %M -> month as string
  90.  
  91.                       %y -> year as 2 decimal numbers "94"
  92.                       %Y -> year as 4 decimal numbers "1994"
  93.  
  94.                       %w -> weekday as short string (Mon,Tue,Wed...)
  95.                       %W -> weekday as string
  96.  
  97.  
  98.                       %S -> Startrek TNG Stardate
  99.                             Descriptions of the algorithms can be found in
  100.                             the TNG and TOS Startrek FAQ`s
  101.                             Short explanation how I did it:
  102.                              example output: "05085.6"
  103.                             -the first digit is the current century (2"0"th)
  104.                             -the second is the Startrek season in the
  105.                              series and the movies. I used the last digit
  106.                              of the current year here since it is stated in
  107.                              the FAQ that this one increases every year
  108.                             -the next 3 digits are the portion of the
  109.                              current year from 0...999, which means:
  110.                              number of the current day (0..365) *1000/365
  111.                             -the ".6" represents the portion of the actual
  112.                              day divided through "2.4".
  113.                             If someone tells me how to convert gregorian
  114.                             date into the julian calendar, I`ll perhaps add
  115.                             an option for the TOS Stardate.
  116.  
  117.  
  118.  
  119.   Examples: OutPutFormat=Time: %h:%n%:%s  Date: %D-%M-%Y
  120.             OutPutFormat=This day is %h hours, %n minutes and %s seconds old
  121.             OutPutFormat=%W, %N-%D-%y %h:%n:%s
  122.  
  123. Gauge=??              This tooltype is for the mem bar showing the amount
  124.                       of free memory. If the (normally blue) bar reaches
  125.                       the right side, your memory is full. :(
  126.                       You may change the width of this gauge by entering
  127.                       values from 1 to 99. A value of 1 represents a width
  128.                       of 10 pixels.
  129.   Example: Gauge=5
  130.  
  131. Memtype=0x??          Here you can enter a c-style hexadecimal mask which
  132.                       type of mem is to be shown in the gauge. It works with
  133.                       standard exec-style Type definitions. (look into the
  134.                       examples, DUDE!)
  135.   Examples: Memtype=0x4   ... shows only free Fastmem
  136.             Memtype=0x2   ... shows only free Chipmem
  137.             Memtype=0x0   ... shows complete free memory
  138.             Memtype=0x1   ... shows Chip- and Fastmemory but not Virtual
  139.                               memory created e.g. by Gigamem® or VMM.
  140.             Memtype=0x20000 . shows largest free memory block
  141.             Memtype=0x20004 . shows largest free Fastmemory block
  142.             .
  143.             .
  144.             .
  145.  
  146.  
  147. Known Bugs / Problems
  148. ---------------------
  149.  
  150. Due to the display system blitting into the Workbench Titlebar Layer
  151. the display may disappear every time you change the current window or
  152. when the amount of free memory changes. I could change this behaviour
  153. but I didn`t want to open a window AND I hate too much patches.
  154.  
  155. If you set the Program`s "toolpri" lower than 0 it may/will happen that
  156. some programs using 100% of the CPU time (like PC-Task) can cause a 
  157. graphics deadlock. That happens when the blitter is already allocated by
  158. those functions used by Titleclock and then the CPU time is stolen by the
  159. Task with the higher priority. If you always use a priority of 5 (default
  160. setting) there shouldn`t be any problems. THE PROGRAM WILL NOT USE MORE 
  161. CPU TIME IN THIS CASE !
  162.  
  163.  
  164. History
  165. --------
  166.  
  167. 1.05 - added the Stardate(TM) option
  168.  
  169. 1.04 - fixed a minor bug, I just forgot to free the workbench screen`s
  170.        drawinfo structure
  171.      - added 12h / PM displaying modes since I were asked to
  172.      *not released*
  173.  
  174. 1.03 - wrote a version for Kickstart 2.0 (english only)
  175.      - from Kick 2.1 onwards now localization supported
  176.      - added some additional security checks
  177.      - added the memtype option for the mem-gauge
  178.      - little "bug" fixed causing some characters not to be deleted when
  179.        using certain proportional fonts (added a space of 6 pixels)
  180.  
  181. 1.02 - added a version with german strings, made the code re-entrant to 
  182.        save some bytes
  183.  
  184. 1.01 - added the mem-gauge
  185.  
  186. 1.00 - first non public testrelease
  187.  
  188.  
  189. Author
  190. ------
  191.  
  192.                          Henryk Richter
  193.                          (Buggs/Defect)
  194.                      Stephan Jantzen Ring 47
  195.                          18106 Rostock
  196.                             Germany
  197.  
  198.            E-MAIL: tfa652@cks1.rz.uni-rostock.de
  199.                    henryk.richter@stud.uni-rostock.de
  200.                    buggs@baltic.e-technik.uni-rostock.de
  201.  
  202.  
  203. Legal Stuff
  204. -----------
  205.  
  206. Titleclock IS Freeware, so use it the way you like.
  207.  
  208.  
  209. Copyright
  210. ---------
  211.  
  212. Titleclock is written and copyright © 1994 by Henryk Richter. No parts of
  213. this program may be altered in any way (this includes editing, re-
  214. programming, crunching, resourceing etc.), except archiving.
  215.  
  216.  
  217. Disclaimer
  218. ----------
  219.  
  220.    THERE  IS  NO  WARRANTY  FOR  THE  PROGRAMS,  TO  THE  EXTENT  PERMITTED BY
  221. APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
  222. AND/OR  OTHER  PARTIES  PROVIDE  THE  PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY
  223. KIND,  EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  224. WARRANTIES  OF  MERCHANTABILITY  AND  FITNESS  FOR  A PARTICULAR PURPOSE.  THE
  225. ENTIRE  RISK  AS  TO  THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU.
  226. SHOULD  THE  PROGRAMS  PROVE  DEFECTIVE,  YOU ASSUME THE COST OF ALL NECESSARY
  227. SERVICING, REPAIR OR CORRECTION.
  228.  
  229.    IN  NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  230. ANY  COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS
  231. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  232. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  233. THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  234. INACCURATE  OR  LOSSES  SUSTAINED  BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  235. PROGRAMS  TO  OPERATE  WITH  ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  236. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  237.  
  238. Shorter: use it on your own risk...
  239.  
  240.  
  241. Distribution
  242. ------------
  243.  
  244. The Distributor may only charge a fee up to the costs of obtaining any
  245. common public domain disk. The distributor agrees to stop distributing the
  246. programs and data involved on request of the author.  The distributor may
  247. only distribute an unmodified copy of the original program, with all the
  248. supplied documentation and copyright notices left intact. The amount of
  249. US $5 shouldn't be exceeded for a disk containing Titleclock.
  250.  
  251.  
  252. ============================= Archive contents =============================
  253.  
  254. Original  Packed Ratio    Date     Time    Name
  255. -------- ------- ----- --------- --------  -------------
  256.     3035    1315 56.6% 30-Jan-95 19:06:54  Titleclock1001.info
  257.     9867    4241 57.0% 01-Feb-95 17:49:30  Titleclock1001/TitleClock1001.doc
  258.     3040    2294 24.5% 28-Dec-94 14:41:40  Titleclock1001/TitleClock1001.doc.info
  259.     3260    2244 31.1% 01-Feb-95 17:46:08  Titleclock1001/TitleClock1001_2.0
  260.     3000    1546 48.4% 30-Jan-95 19:14:34  Titleclock1001/TitleClock1001_2.0.info
  261.     3140    2170 30.8% 01-Feb-95 17:46:18  Titleclock1001/TitleClock1001_2.1
  262.     3001    1548 48.4% 30-Jan-95 19:14:12  Titleclock1001/TitleClock1001_2.1.info
  263.     3032    2084 31.2% 01-Feb-95 17:46:24  Titleclock1001/TitleClock1001_3.x
  264.     3002    1553 48.2% 30-Jan-95 19:08:48  Titleclock1001/TitleClock1001_3.x.info
  265. -------- ------- ----- --------- --------
  266.    34377   18995 44.7% 03-Feb-95 14:03:36   9 files
  267.